.. _`Match Template`:

.. _`com.sympathyfordata.imageanalysis.match_template`:

Match Template
``````````````

.. image:: image_template.svg
   :width: 48


Uses cross-correlation to match a template image to an image. Returns an image with maxima where the template matches.




Documentation
:::::::::::::

Uses cross-correlation to match a template image to an image.
Returns an image with maxima where the template matches.


Definition
::::::::::


Input ports
...........

    **image**  image
        image to perform matching on

    **template**  image
        Template image


Output ports
............

    **result**  image
        result after matching




Configuration
.............

    **Pad value** (k)
        Value used for padding mode "constant"
    **Padding mode** (padding mode)
        Method used for padding the input







Examples
........

* :download:`Template_Matching_and_Arrange.syx </Examples/Image Analysis/Template_Matching_and_Arrange.syx>`




Implementation
..............

.. automodule:: node_correlation
    :noindex:

.. class:: MatchTemplate
    :noindex: